home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1992 June: ROMin Holiday / ADC Developer CD (1992-06) (''ROMin Holiday'')_iso / Developer Connection - 06-1992.iso / Development Platforms / Apple II / Essentials / APW.ORCA.Cmds / Gregs.APW.Utils / Documentation / DirFF < prev    next >
Encoding:
Text File  |  1990-07-19  |  4.3 KB  |  89 lines  |  [TEXT/pdos]
  1. DirFF -- Display directory of files contained in the FastFile subsystem.
  2.  
  3. Syntax      DirFF
  4.  
  5. Description In version 1.1 of the ORCA shell, ByteWorks introduced the FastFile
  6.             high level file caching subsystem.  This system works by loading
  7.             and managing disk images of files in memory for quicker access by
  8.             compilers, linkers, and other tools that work with the FastFile
  9.             system.  (See the appropropriate Orca/M documentation for details.)
  10.  
  11.             One side effect of the FastFile system is that memory is used to
  12.             keep these file images in memory.  This means that less memory is
  13.             available for use by the rest of the system.  This utility is used
  14.             to display exactly which files are currently being maintained by
  15.             the subsystem, and the various attributes of the file.  This
  16.             directory listing is very much like a normal directory listing
  17.             produced by the 'Catalog' command, with the following differences.
  18.  
  19.             The 'Blocks' field contain the number of disk blocks that are used
  20.             (or would be used) by the disk copy of the file.  If an asterisk
  21.             (*) appears after the number for a particular file, it means that
  22.             the memory block for the file within the FastFile system has been
  23.             purged, and that the memory image of the file is not actually using
  24.             any memory.
  25.  
  26.             The 'Flags' field corresponds to the flags byte of the FastFile
  27.             system call.  If a 'D' appears in this field, it means that the
  28.             file exists on disk as well as within the FastFile system.  In some
  29.             cases, parts of the development system can pass files between
  30.             themselves by using the FastFile system entirely and skipping the
  31.             actual writing of the file to disk.  For example, when the +M flag
  32.             is specified in an ASML command, the assembler creates the object
  33.             file in the FastFile system only for use by the Linker.  The object
  34.             file does not get written to disk.
  35.  
  36.             If a 'P' appears in the flags field, it means that FastFile system
  37.             will allow a FastFile PURGE call on this particular file.
  38.  
  39.             The two digits in the remainder of the 'Flags' field correspond to
  40.             the current purge level of the memory block containing the file.
  41.             This can be any number from '00' to '03'.  See the Memory Manager
  42.             chapter of the Apple IIGS Toolbox Reference Manual for a
  43.             description of purge levels.
  44.  
  45.             At the conclusion of the directory listing, the utility will
  46.             display the total number of files found within the FastFile system,
  47.             and an accumulated total of the number of bytes of memory used by
  48.             files within the FastFile system.  This value is determined by
  49.             performing a GetHandleSize on each non-purged file handle found
  50.             within the FastFile system.
  51.  
  52. Input       None.
  53.  
  54. Ouput       The directory listing is displayed on the standard output device.
  55.  
  56. Diagnostics Error messages are written to the diagnostic output device.
  57.  
  58. Status      The following status codes may be returned to the APW shell:
  59.  
  60.             0   No errors.
  61.             -1  Command-Period pressed.
  62.             <any>   Any other return value is the disk error number returned by
  63.                     a GS/OS or FastFile call.
  64.  
  65. Options     None.
  66.  
  67. Example     With the following command entered on the command line:
  68.  
  69.             DirFF
  70.  
  71.             The following output was produced:
  72.  
  73. Files in FastFile system:
  74.  
  75. Name            Type  Blocks   Modified         Created         Access  Flags
  76.  
  77. CLRFF           TXT        5  18 Jun 90 12:01  18 Jun 90 10:55  DNB WR  DP 00  
  78. DIRFF           TXT        3  18 Jun 90 11:44  18 Jun 90 10:55  DNB WR  DP 00  
  79. PAGEEJECT       TXT        3* 18 Jun 90 11:28  18 Jun 90 10:55  DNB WR  DP 02  
  80. EJECT           TXT        5  18 Jun 90 11:24  18 Jun 90 10:55  DNB WR  DP 00  
  81. SETFILE         TXT        9  18 Jun 90 10:55  18 Jun 90 10:55  DNB WR  DP 00  
  82. SYSTABS         SRC        7  10 Aug 89 18:43   9 Nov 88 15:00  DNB WR  DP 00  
  83. SYSEMAC         BIN        8  25 Jul 89 14:39   9 Nov 88 15:00  DNB WR  DP 00  
  84.  
  85. 7 files for a total of   48309 bytes of memory used.
  86.  
  87.  
  88. See Also    ClrFF.
  89.